[NbConvertApp] Using existing profile dir: u'/Users/claireellis/.ipython/profile_default'
[NbConvertApp] WARNING | pattern u'/Users/claireolson/Dropbox/Lab (1)/IPython_nbs/Claire/Annotations_GeneFeatures_CGs' matched no files
This application is used to convert notebook files (*.ipynb) to various other
formats.
WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.
Options
-------
Arguments that take values are actually convenience aliases to full
Configurables, whose aliases are listed on the help line. For more information
on full configurables, see '--help-all'.
--debug
set log level to logging.DEBUG (maximize logging output)
--init
Initialize profile with default config files. This is equivalent
to running `ipython profile create <profile>` prior to startup.
--quiet
set log level to logging.CRITICAL (minimize logging output)
--stdout
Write notebook output to stdout instead of files.
--profile=<Unicode> (BaseIPythonApplication.profile)
Default: u'default'
The IPython profile to use.
--reveal-prefix=<Unicode> (RevealHelpPreprocessor.url_prefix)
Default: 'reveal.js'
The URL prefix for reveal.js. This can be a a relative URL for a local copy
of reveal.js, or point to a CDN.
For speaker notes to work, a local reveal.js prefix must be used.
--ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
Default: u''
The name of the IPython directory. This directory is used for logging
configuration (through profiles), history storage, etc. The default is
usually $HOME/.ipython. This options can also be specified through the
environment variable IPYTHONDIR.
--writer=<DottedObjectName> (NbConvertApp.writer_class)
Default: 'FilesWriter'
Writer class used to write the results of the conversion
--log-level=<Enum> (Application.log_level)
Default: 30
Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
Set the log level by value or name.
--to=<CaselessStrEnum> (NbConvertApp.export_format)
Default: 'html'
Choices: ['custom', 'html', 'latex', 'markdown', 'python', 'rst', 'slides']
The export format to be used.
--template=<Unicode> (TemplateExporter.template_file)
Default: u'default'
Name of the template file to use
--output=<Unicode> (NbConvertApp.output_base)
Default: ''
overwrite base name use for output files. can only be use when converting
one notebook at a time.
--post=<DottedOrNone> (NbConvertApp.postprocessor_class)
Default: u''
PostProcessor class used to write the results of the conversion
--config=<Unicode> (BaseIPythonApplication.extra_config_file)
Default: u''
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
--profile-dir=<Unicode> (ProfileDir.location)
Default: u''
Set the profile location directly. This overrides the logic used by the
`profile` option.
To see all available configurables, use `--help-all`
Examples
--------
The simplest way to use nbconvert is
> ipython nbconvert mynotebook.ipynb
which will convert mynotebook.ipynb to the default format (probably HTML).
You can specify the export format with `--to`.
Options include ['custom', 'html', 'latex', 'markdown', 'python', 'rst', 'slides']
> ipython nbconvert --to latex mynotebook.ipynb
Both HTML and LaTeX support multiple output templates. LaTeX includes
'base', 'article' and 'report'. HTML includes 'basic' and 'full'. You
can specify the flavor of the format used.
> ipython nbconvert --to html --template basic mynotebook.ipynb
You can also pipe the output to stdout, rather than a file
> ipython nbconvert mynotebook.ipynb --stdout
A post-processor can be used to compile a PDF
> ipython nbconvert mynotebook.ipynb --to latex --post PDF
You can get (and serve) a Reveal.js-powered slideshow
> ipython nbconvert myslides.ipynb --to slides --post serve
Multiple notebooks can be given at the command line in a couple of
different ways:
> ipython nbconvert notebook*.ipynb
> ipython nbconvert notebook1.ipynb notebook2.ipynb
or you can specify the notebooks list in a config file, containing::
c.NbConvertApp.notebooks = ["my_notebook.ipynb"]
> ipython nbconvert --config mycfg.py